Skip to content

Conversation

Copy link

Copilot AI commented Jun 27, 2025

This PR addresses formatting inconsistencies in README files throughout the repository to improve professionalism and consistency.

Changes Made

1. Added OpenTelemetry splash image to main README.md

The main README was missing the OpenTelemetry splash logo that is present in most other READMEs. Added consistent branding:

![OpenTelemetry — An observability framework for cloud-native software.][splash]

[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png

2. Removed trailing whitespace

Fixed trailing spaces in multiple README files:

  • README.md (lines 101, 109)
  • opentelemetry-prometheus/README.md
  • opentelemetry-zipkin/examples/README.md
  • opentelemetry-otlp/tests/integration_test/actual/README.md

3. Fixed grammar error

Corrected "get start crates" to "get started with crates" in examples/README.md for better readability.

Impact

  • Improved visual consistency across all README files
  • Enhanced professional appearance with proper branding
  • Cleaner formatting without trailing whitespace
  • Better grammar for improved readability

All changes are cosmetic and do not affect functionality. The modifications follow existing patterns used throughout the repository.

Fixes #1.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Improve README formatting Improve README formatting consistency across repository Jun 27, 2025
Copilot AI requested a review from trask June 27, 2025 17:08
Copilot finished work on behalf of trask June 27, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve README formatting

2 participants